Review request for Microsoft.ContainerService to add version 2022-07-02-preview #20062
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…w/2022-06-02-preview to version 2022-07-02-preview
…review (#19874) * add example of kv secret provider addon * fix * fix lint
* move ADH GA type to preview * fix prettier check issue
* add overlay vpa objects * fix typo * address comments Co-authored-by: zhifanhui <[email protected]>
* Swagger API for Operation Abort * Swagger changes updates for Abort operation based on validations
* add SecuredByPerimeter in publicNetworkAccess * update enum value descriptions
* Add support for ImageCleaner on AKS * add more context in ImageCleaner description
|
Hi, @FumingZhang Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @FumingZhang your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
Swagger Validation Report
|
| compared swaggers (via Oad v0.9.6)] | new version | base version |
|---|---|---|
| fleets.json | 2022-07-02-preview(5dbedf7) | 2022-06-02-preview(main) |
| managedClusters.json | 2022-07-02-preview(5dbedf7) | 2022-06-01(main) |
| managedClusters.json | 2022-07-02-preview(5dbedf7) | 2022-06-02-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
| Rule | Message |
|---|---|
|
The new version adds a response code 'default'. New: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L1292:11 |
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| The new version adds a response code 'default'. New: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L1292:11 |
|
| The new version has a different format than the previous one. New: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L3474:9 Old: Microsoft.ContainerService/preview/2022-06-02-preview/managedClusters.json#L3378:9 |
|
| The new version has a different format than the previous one. New: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L3474:9 Old: Microsoft.ContainerService/preview/2022-06-02-preview/managedClusters.json#L3378:9 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 16 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-preview-2022-07 | package-preview-2022-07(5dbedf7) | default(main) |
The following errors/warnings are introduced by current PR:
| Rule | Message |
|---|---|
| The child tracked resource, 'members' with immediate parent 'Fleet', must have a list by immediate parent operation. Location: Microsoft.ContainerService/preview/2022-07-02-preview/fleets.json#L703 |
|
| The child tracked resource, 'trustedAccessRoleBindings' with immediate parent 'ManagedCluster', must have a list by immediate parent operation. Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L6811 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableCustomCATrust Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L3391 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableNamespaceResources Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L4355 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableVnetIntegration Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L4629 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L5079 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L6263 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L6277 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L6287 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L6302 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L6346 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableRbac Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L6502 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L6863 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L6875 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L6971 |
|
| 'ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L6872 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The response schema of operations API '/providers/Microsoft.ContainerService/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L37 |
|
The private endpoint model 'PrivateLinkResourcesListResult' schema does not conform to the common type definition. Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L5575 |
| Per the Noun_Verb convention for Operation Ids, the noun 'AgentPools' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L1268 |
|
| 'PUT' operation 'PrivateEndpointConnections_Update' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L1722 |
|
| The operation 'ManagedClusters_GetCommandResult' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L2034 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L1823 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L1977 |
|
| Based on the response model schema, operation 'PrivateEndpointConnections_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L1627 |
|
| Based on the response model schema, operation 'PrivateLinkResources_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L1884 |
|
| OperationId should contain the verb: 'listcredential' in:'ManagedClusters_GetAccessProfile'. Consider updating the operationId Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L244 |
|
| OperationId should contain the verb: 'resolveprivatelinkserviceid' in:'ResolvePrivateLinkServiceId_POST'. Consider updating the operationId Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L1931 |
|
| The child tracked resource, 'agentPools' with immediate parent 'ManagedCluster', must have a list by immediate parent operation. Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L3584 |
|
| The child tracked resource, 'commandResults' with immediate parent 'ManagedCluster', must have a list by immediate parent operation. Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L3956 |
|
| The child tracked resource, 'privateEndpointConnections' with immediate parent 'ManagedCluster', must have a list by immediate parent operation. Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L5479 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableAutoScaling Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L3334 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableNodePublicIP Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L3386 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableEncryptionAtHost Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L3448 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableUltraSSD Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L3453 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableFIPS Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L3457 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableCSIProxy Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L3633 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L3651 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableMultipleStandardLoadBalancers Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L4124 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L4187 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableRBAC Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L4347 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enablePodSecurityPolicy Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L4351 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: disableLocalAccounts Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L4514 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enablePrivateCluster Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L4611 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enablePrivateClusterPublicFQDN Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L4621 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: disableRunCommand Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L4625 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: managed Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L4860 |
️❌Avocado: 1 Errors, 0 Warnings failed [Detail]
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️⚠️SDK Track2 Validation: 1 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/5dbedf756e51a0f970767e5ef3fd0d7d42091db0/specification/containerservice/resource-manager/readme.md#tag-package-preview-2022-07">containerservice/resource-manager/readme.md#package-preview-2022-07
| Rule | Message |
|---|---|
| "readme":"containerservice/resource-manager/readme.md", "tag":"package-preview-2022-07", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
ghost
added
the
Swagger Generation Artifacts
|
Generated ApiView
|
FumingZhang
added
the
DoNotMerge
|
Hi @FumingZhang, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Hi @FumingZhang, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
This was referenced Aug 2, 2022
FumingZhang
requested review from
msyyc,
BigCat20196,
ArcturusZhang,
palma21,
matthchr and
circy9
as code owners
jorgecotillo
added
ARMSignedOff
FumingZhang
removed
the
DoNotMerge
|
New work item used to track the breaking change review. |
3 tasks
JeffreyRichter
added
the
Approved-BreakingChange
jianyexi
approved these changes
Aug 18, 2022
This was referenced Aug 18, 2022
25 tasks
11 tasks
FumingZhang
deleted the
dev-containerservice-Microsoft.ContainerService-2022-07-02-preview
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
Expected to complete deployment to all global regions on 2022/08/11.
2022/08/11.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.